package design.mode.chapter3.item4.generator3;

import com.google.common.annotations.VisibleForTesting;

import java.net.Inet4Address;
import java.net.UnknownHostException;
import java.util.Random;

/**
 * 提高代码的可测试性
 * 从 getLastfieldOfHostName() 函数中，将逻辑比较复杂的那部分代码剥离出来，定义为 getLastSubstrSplittedByDot() 函数。
 * 因为 getLastfieldOfHostName() 函数依赖本地主机名，所以，剥离出主要代码之后这个函数变得非常简单，可以不用测试。
 * <p>
 * 我们重点测试 getLastSubstrSplittedByDot() 函数即可。
 * 将 generateRandomAlphameric() 和 getLastSubstrSplittedByDot() 这两个函数的访问权限设置为 protected。
 * 这样做的目的是，可以直接在单元测试中通过对象来调用两个函数进行测试。
 * 给 generateRandomAlphameric() 和 getLastSubstrSplittedByDot() 两个函数添加 Google Guava 的 annotation @VisibleForTesting。
 * <p>
 * 这个 annotation 没有任何实际的作用，只起到标识的作用，告诉其他人说，这两个函数本该是 private 访问权限的，
 * 之所以提升访问权限到 protected，只是为了测试，只能用于单元测试中。
 *
 * @author ZhongMingde on 2021/10/21
 */

/**
 * Id用于生成随机Id的生成器。
 * 由该类生成的id不是绝对唯一的，但复制的概率非常低。
 */
public class RandomIdGenerator implements LogTraceIdGenerator {
    String substrOfHostName = null;

    @Override
    public String generator() throws IdGenerationFailureException {
        try {
            substrOfHostName = getLastFieldOfHostName();
        } catch (UnknownHostException e) {
            throw new IdGenerationFailureException("host name is empty.");
        }
        long currentTimeMillis = System.currentTimeMillis();
        String randomString = generateRandomAlphameric(8);
        String id = String.format("%s-%d-%s", substrOfHostName, currentTimeMillis, randomString);
        return id;
    }

    /**
     * 获取本地主机名并*
     * 提取由分隔符'.'分隔的名称字符串的最后一个字段。
     *
     * @return
     * @返回主机名的最后一个字段。如果没有获得主机名，则返回null
     */
    // 获取主机名失败会影响后续逻辑的处理，并不是我们期望的，所以，它是一种异常行为。
    private String getLastFieldOfHostName() throws UnknownHostException {
        String substrOfHostName = null;
        String hostName = Inet4Address.getLocalHost().getHostName();
        // 我们在使用这个函数的时候，自己也要保证不传递 NULL 值或者空字符串进去
        if (hostName == null || hostName.isEmpty()) { // 此处做判断
            throw new UnknownHostException("...");
        }
        substrOfHostName = getLastSubstrSplittedByDot(hostName);
        return substrOfHostName;
    }


    /**
     * 获取{@hostName}被分隔符'.'分隔的最后一个字段。*
     *
     * @param hostName 不应该为空*
     * @return {@hostName}的最后一个字段。如果{@hostName}是空字符串，则返回空字符串。
     */

    @VisibleForTesting
    protected String getLastSubstrSplittedByDot(String hostName) {
        // 谁也保证不了程序员就一定不会传递 NULL 值或者空字符串
        if (hostName == null || hostName.isEmpty()) {
            throw new IllegalArgumentException("..."); //运行时异常
        }
        String[] tokens = hostName.split("\\.");
        String subStrOfHostName = tokens[tokens.length - 1];
        return subStrOfHostName;
    }

    /**
     * 随机数生成
     *
     * @param length
     * @return
     */
    @VisibleForTesting
    protected String generateRandomAlphameric(int length) {
        if (length <= 0) {
            throw new IllegalArgumentException("...");
        }
        char[] randomChars = new char[length];
        int count = 0;
        Random random = new Random();
        while (count < length) {
            int maxAscii = 'z';
            int randomAscii = random.nextInt(maxAscii);
            boolean isDigit = randomAscii >= '0' && randomAscii <= '9';
            boolean isUppercase = randomAscii >= 'A' && randomAscii <= 'Z';
            boolean isLowercase = randomAscii >= 'a' && randomAscii <= 'z';
            if (isDigit || isUppercase || isLowercase) {
                randomChars[count] = (char) (randomAscii);
                ++count;
            }
        }
        return new String(randomChars);
    }

}
